ADR for updated data model #182
Open
+131
−3
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jacksonj04
force-pushed
the
adr/document-data-structure
branch
2 times, most recently
from
d8e9977 to
992bbe1
Compare
dragon-dxw
reviewed
Nov 11, 2024
dragon-dxw
reviewed
Nov 11, 2024
dragon-dxw
reviewed
Nov 11, 2024
dragon-dxw
reviewed
Nov 11, 2024
jacksonj04
force-pushed
the
adr/document-data-structure
branch
2 times, most recently
from
9007447 to
720037a
Compare
This proposes a richer data structure to help us model how the various parts of "a decision" exist within the service, both logically and conceptually.
jacksonj04
force-pushed
the
adr/document-data-structure
branch
from
720037a to
7ede3ce
Compare
dragon-dxw
reviewed
Nov 14, 2024
|
|
||
| Documents are the overarching item in the data structure, and are what most people will actually mean when they talk about a "judgment". Each document MUST be assigned a unique, non-semantic identifier by the Find Case Law service, and may have one or more other identifiers such as NCNs. | ||
|
|
||
| Where a relationship exists between two documents (eg "X is a press summary of Y") this relationship would likely be stored bidirectionally, ie "is summarised by" and "is a summary of" to simplify retrieval. |
There was a problem hiding this comment.
I think it's worth being specific that a judgment and its press summary are different documents, and that we don't yet have a settled opinion on language.
There was a problem hiding this comment.
What does the relationship of revisions to its document look like?
dragon-dxw
reviewed
Nov 14, 2024
|
|
||
| A revision represents a distinct submission of a document to the National Archives, usually by a court or tribunal. For new submissions this will usually be via TDR, but some legacy ingestions may have been done via other means. | ||
|
|
||
| A revision SHOULD have a "source document" which we consider to be the canonical representation of the revision, and from which all other representations are derived. This will usually be a .docx file for all new submissions, but could also be other types of file for legacy ingestions or future submissions. It is possible that legacy ingestions will no longer have the original file available for all past revisions (although this will remain in The National Archives' preservation system). |
There was a problem hiding this comment.
is the source document in practice a link to S3 and maybe a hash of that file?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Our existing data model is starting to creak under the load, and needs a bit of a refresh. This ADR proposes a new structure for the data to better support future requirements.